
<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
      
        <meta name="author" content="HENG">
      
      
      
        <link rel="prev" href="docs.html">
      
      
      
      <link rel="icon" href="assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.20">
    
    
      
        <title>脚本网页 - FastAPI</title>
      
    
    
      <link rel="stylesheet" href="assets/stylesheets/main.66ac8b77.min.css">
      
      


    
    
      
    
    
      
        
        
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
    
    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      

    
    
    
  </head>
  
  
    <body dir="ltr">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#_1" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
    
      

  

<header class="md-header md-header--shadow" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="index.html" title="FastAPI" class="md-header__button md-logo" aria-label="FastAPI" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            FastAPI
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              脚本网页
            
          </span>
        </div>
      </div>
    </div>
    
    
      <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
    
    
    
      <label class="md-header__button md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
      </label>
      <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
  </nav>
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
        
          
        
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    



<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="index.html" title="FastAPI" class="md-nav__button md-logo" aria-label="FastAPI" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

    </a>
    FastAPI
  </label>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="index.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    主页
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="dev.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    开发
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="exam.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    测试
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="code.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    代码
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="docs.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    文档
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
    
  
  
  
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          
  
  <span class="md-ellipsis">
    脚本网页
  </span>
  

          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="script.html" class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    脚本网页
  </span>
  

      </a>
      
        

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#_1" class="md-nav__link">
    <span class="md-ellipsis">
      项目名称
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_2" class="md-nav__link">
    <span class="md-ellipsis">
      项目简介
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_3" class="md-nav__link">
    <span class="md-ellipsis">
      发起时间
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_4" class="md-nav__link">
    <span class="md-ellipsis">
      技术选型
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_5" class="md-nav__link">
    <span class="md-ellipsis">
      接口设计
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_6" class="md-nav__link">
    <span class="md-ellipsis">
      前端代码
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_7" class="md-nav__link">
    <span class="md-ellipsis">
      后端代码
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#_1" class="md-nav__link">
    <span class="md-ellipsis">
      项目名称
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_2" class="md-nav__link">
    <span class="md-ellipsis">
      项目简介
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_3" class="md-nav__link">
    <span class="md-ellipsis">
      发起时间
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_4" class="md-nav__link">
    <span class="md-ellipsis">
      技术选型
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_5" class="md-nav__link">
    <span class="md-ellipsis">
      接口设计
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_6" class="md-nav__link">
    <span class="md-ellipsis">
      前端代码
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_7" class="md-nav__link">
    <span class="md-ellipsis">
      后端代码
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  


  <h1>脚本网页</h1>

<h3 id="_1">项目名称</h3>
<p>脚本存储网页</p>
<h3 id="_2">项目简介</h3>
<p>本项目旨在创建一个网页，用于存储和展示各种命令，用户可以通过粘贴复制命令到服务器来完成nginx、MySQL等软件的安装任务。项目还包含各种异常处理机制，确保用户在执行命令时能够避免潜在的问题。</p>
<h3 id="_3">发起时间</h3>
<p>2024/5/7</p>
<h3 id="_4">技术选型</h3>
<p>后端 python3.6 ，fastapi
前端 Vue</p>
<h3 id="_5">接口设计</h3>
<ol>
<li>获取脚本列表
   请求方法：GET</li>
</ol>
<p>请求路径：/v1/scripts
请求参数：无
响应示例：</p>
<pre><code>{
&quot;data&quot;: [
{
&quot;id&quot;: 1,
&quot;name&quot;: &quot;安装nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get install nginx&quot;
},
{
&quot;id&quot;: 2,
&quot;name&quot;: &quot;安装MySQL&quot;,
&quot;command&quot;: &quot;sudo apt-get install mysql-server&quot;
}
]
}
</code></pre>
<ol>
<li>创建脚本
   请求方法：POST</li>
</ol>
<p>请求路径：/v1/scripts</p>
<p>请求参数：</p>
<table>
<thead>
<tr>
<th>参数名</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>string</td>
<td>是</td>
<td>脚本名称</td>
</tr>
<tr>
<td>command</td>
<td>string</td>
<td>是</td>
<td>脚本命令</td>
</tr>
</tbody>
</table>
<p>请求示例：</p>
<pre><code>{
&quot;name&quot;: &quot;安装nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get install nginx&quot;
}
响应示例：

{
&quot;data&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;安装nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get install nginx&quot;
}
}
</code></pre>
<ol>
<li>更新脚本
   请求方法：PUT</li>
</ol>
<p>请求路径：/v1/scripts/{id}</p>
<p>请求参数：</p>
<table>
<thead>
<tr>
<th>参数名</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>int</td>
<td>是</td>
<td>脚本ID</td>
</tr>
<tr>
<td>name</td>
<td>string</td>
<td>否</td>
<td>脚本名称</td>
</tr>
<tr>
<td>command</td>
<td>string</td>
<td>否</td>
<td>脚本命令</td>
</tr>
<tr>
<td>请求示例：</td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>{
&quot;name&quot;: &quot;更新nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get update &amp;&amp; sudo apt-get install nginx&quot;
}
响应示例：

{
&quot;data&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;更新nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get update &amp;&amp; sudo apt-get install nginx&quot;
}
}
</code></pre>
<ol>
<li>删除脚本
   请求方法：DELETE</li>
</ol>
<p>请求路径：/v1/scripts/{id}</p>
<p>请求参数：</p>
<table>
<thead>
<tr>
<th>参数名</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>int</td>
<td>是</td>
<td>脚本ID</td>
</tr>
<tr>
<td>响应示例：</td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>{
&quot;data&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;更新nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get update &amp;&amp; sudo apt-get install nginx&quot;
}
}
</code></pre>
<ol>
<li>获取脚本详情
   请求方法：GET</li>
</ol>
<p>请求路径：/v1/scripts/{id}</p>
<p>请求参数：</p>
<table>
<thead>
<tr>
<th>参数名</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>int</td>
<td>是</td>
<td>脚本ID</td>
</tr>
<tr>
<td>响应示例：</td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>{
&quot;data&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;更新nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get update &amp;&amp; sudo apt-get install nginx&quot;
}
}
</code></pre>
<ol>
<li>搜索脚本
   请求方法：GET</li>
</ol>
<p>请求路径：/v1/scripts/search?q={query}</p>
<p>请求参数：</p>
<table>
<thead>
<tr>
<th>参数名</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>query</td>
<td>string</td>
<td>是</td>
<td>搜索关键词</td>
</tr>
<tr>
<td>响应示例：</td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>{
&quot;data&quot;: [
{
&quot;id&quot;: 1,
&quot;name&quot;: &quot;安装nginx&quot;,
&quot;command&quot;: &quot;sudo apt-get install nginx&quot;
},
{
&quot;id&quot;: 2,
&quot;name&quot;: &quot;安装MySQL&quot;,
&quot;command&quot;: &quot;sudo apt-get install mysql-server&quot;
}
]
}
</code></pre>
<h3 id="_6">前端代码</h3>
<p>前端代码主要负责展示用户界面和与后端进行通信</p>
<p>组件（Components）：Vue.js组件用于构建用户界面。组件可以是简单的HTML元素，也可以是复杂的用户界面部分。在本项目中，我们可能会有以下组件：
ScriptList.vue：用于显示脚本列表。
ScriptForm.vue：用于创建和更新脚本。
ScriptDetail.vue：用于显示脚本详情。
路由（Routes）：Vue Router用于管理应用程序的路由。在本项目中，我们可能会有以下路由：
/scripts：显示脚本列表。
/scripts/create：创建新脚本。
/scripts/:id：显示脚本详情。
/scripts/:id/edit：更新脚本。
状态管理（State Management）：Vuex用于管理应用程序的状态。在本项目中，我们可能会有一个Vuex store来存储脚本列表、当前选中的脚本等状态。
API请求（API Requests）：使用axios或fetch等HTTP客户端与后端进行通信。在本项目中，我们需要实现以下API请求：
GET /v1/scripts：获取脚本列表。
POST /v1/scripts：创建新脚本。
PUT /v1/scripts/:id：更新脚本。
DELETE /v1/scripts/:id：删除脚本。
GET /v1/scripts/:id：获取脚本详情。
GET /v1/scripts/search?q={query}：搜索脚本。</p>
<h3 id="_7">后端代码</h3>
<p>后端代码主要负责处理API请求和与数据库进行通信。以下是后端代码的主要部分：</p>
<p>路由（Routes）：FastAPI使用路由来处理API请求。在本项目中，我们需要实现以下路由：
GET /v1/scripts：获取脚本列表。
POST /v1/scripts：创建新脚本。
PUT /v1/scripts/{id}：更新脚本。
DELETE /v1/scripts/{id}：删除脚本。
GET /v1/scripts/{id}：获取脚本详情。
GET /v1/scripts/search?q={query}：搜索脚本。
数据模型（Data Models）：使用Pydantic或SQLAlchemy等库定义数据模型。在本项目中，我们需要定义一个Script模型，包含id、name和command等字段。
数据库（Database）：使用SQLite、PostgreSQL等数据库存储脚本数据。在本项目中，我们可能会使用SQLite作为数据库。
异常处理（Error Handling）：在后端代码中，我们需要处理各种异常，例如数据库错误、验证错误等。我们可以使用FastAPI的异常处理机制来实现这一点。
中间件（Middleware）：FastAPI支持中间件，可以用于实现诸如身份验证、日志记录等功能。在本项目中，我们可能会使用中间件来处理跨域资源共享（CORS）问题。</p>












                
              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
      </main>
      
        <footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
    
    <script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
    
    
      <script src="assets/javascripts/bundle.dd8806f2.min.js"></script>
      
    
  </body>
</html>